home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cato / Xm / XmDropTransfer.z / XmDropTransfer
Encoding:
Text File  |  1998-10-20  |  13.5 KB  |  199 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr - The DropTransfer widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////DDDDrrrraaaaggggDDDDrrrroooopppp....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           DropTransfer provides a set of resources that identifies the
  20.           procedures and associated information required by the
  21.           toolkit in order to process and complete a drop transaction.
  22.           Clients should not explicitly create a DropTransfer widget.
  23.           Instead, a client initiates a transfer by calling
  24.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt, which initializes and returns a
  25.           DropTransfer widget.  If this function is called within an
  26.           XXXXmmmmNNNNddddrrrrooooppppPPPPrrrroooocccc callback, the actual transfers are initiated
  27.           after the callback returns.  Even if no data needs to be
  28.           transferred, XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt needs to be called
  29.           (typically with no arguments, or just setting
  30.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss) to finish the drag and drop transaction.
  31.  
  32.           The XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss resource specifies a transfer list that
  33.           describes the requested target types for the source data.  A
  34.           transfer list is an array of XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc
  35.           structures, each of which identifies a target type.  The
  36.           transfer list is analogous to the MULTIPLE selections
  37.           capability defined in the _I_n_t_e_r-_C_l_i_e_n_t _C_o_m_m_u_n_i_c_a_t_i_o_n
  38.           _C_o_n_v_e_n_t_i_o_n_s _M_a_n_u_a_l (ICCCM).
  39.  
  40.           The DropTransfer resource, XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc, specifies a
  41.           transfer procedure of type XtSelectionCallbackProc that
  42.           delivers the requested selection data.  This procedure
  43.           operates in conjunction with the underlying Xt selection
  44.           capabilities and is called for each target in the transfer
  45.           list.  Additional target types can be requested after a
  46.           transfer is initiated by calling the XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd
  47.           function.
  48.  
  49.         SSSSttttrrrruuuuccccttttuuuurrrreeeessss
  50.           An XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy is a pointer to the following
  51.           structure of type XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc, which identifies a
  52.           selection target associated with a given drop transaction:
  53.  
  54.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  55.           {{{{
  56.             XXXXttttPPPPooooiiiinnnntttteeeerrrr _c_l_i_e_n_t__d_a_t_a;;;;
  57.             AAAAttttoooommmm      _t_a_r_g_e_t;;;;
  58.           }}}} XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyyRRRReeeecccc,,,, ****XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrEEEEnnnnttttrrrryyyy;;;;
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           _c_l_i_e_n_t__d_a_t_a
  75.                     Specifies any additional information required by
  76.                     this selection target
  77.  
  78.           _t_a_r_g_e_t    Specifies a selection target associated with the
  79.                     drop operation
  80.  
  81.  
  82.         CCCCllllaaaasssssssseeeessss
  83.           DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  84.  
  85.           The class pointer is xxxxmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrOOOObbbbjjjjeeeeccccttttCCCCllllaaaassssssss.
  86.  
  87.           The class name is XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr.
  88.  
  89.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  90.           The following table defines a set of widget resources used
  91.           by the programmer to specify data.  The programmer can also
  92.           set the resource values for the inherited classes to set
  93.           attributes for this widget.  To reference a resource by name
  94.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  95.           prefix and use the remaining letters.  To specify one of the
  96.           defined values for a resource in a .Xdefaults file, remove
  97.           the XXXXmmmm prefix and use the remaining letters (in either
  98.           lowercase or uppercase, but include any underscores between
  99.           words).  The codes in the access column indicate if the
  100.           given resource can be set at creation time (CCCC), set by using
  101.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (SSSS), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (GGGG), or is
  102.           not applicable (NNNN////AAAA).
  103.  
  104.                                         XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  105.      NNNNaaaammmmeeee                  CCCCllllaaaassssssss                 TTTTyyyyppppeeee                       DDDDeeeeffffaaaauuuulllltttt              AAAAcccccccceeeessssssss
  106.      __________________________________________________________________________________________________
  107.      XmNdropTransfers      XmCDropTransfers      XmDropTransferEntryRec *   NULL                 CG
  108.      XmNincremental        XmCIncremental        Boolean                    False                CSG
  109.      XmNnumDropTransfers   XmCNumDropTransfers   Cardinal                   0                    CSG
  110.      XmNtransferProc       XmCTransferProc       XtSelectionCallbackProc    NULL                 CSG
  111.      XmNtransferStatus     XmCTransferStatus     unsigned char              XmTRANSFER_SUCCESS   CSG
  112.  
  113.           XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
  114.                     Specifies the address of an array of drop transfer
  115.                     entry records.  The drop transfer is complete when
  116.                     all the entries in the list have been processed.
  117.  
  118.           XXXXmmmmNNNNiiiinnnnccccrrrreeeemmmmeeeennnnttttaaaallll
  119.                     Specifies a Boolean value that indicates whether
  120.                     the transfer on the receiver side uses the Xt
  121.                     incremental selection transfer mechanism described
  122.                     in _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e _I_n_t_e_r_f_a_c_e.  If
  123.                     the value is True, the receiver uses incremental
  124.                     transfer; if the value is False, the receiver uses
  125.                     atomic transfer.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrr((((3333XXXX))))
  137.  
  138.  
  139.  
  140.           XXXXmmmmNNNNnnnnuuuummmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss
  141.                     Specifies the number of entries in
  142.                     XXXXmmmmNNNNddddrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrssss.  If this resource is set to 0 at
  143.                     any time, the transfer is considered complete.
  144.                     The value of XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss determines the
  145.                     completion handshaking process.
  146.  
  147.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrPPPPrrrroooocccc
  148.                     Specifies a procedure of type
  149.                     XXXXttttSSSSeeeelllleeeeccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkkPPPPrrrroooocccc that delivers the
  150.                     requested selection values.  The _w_i_d_g_e_t argument
  151.                     passed to this procedure is the DropTransfer
  152.                     widget.  The selection atom passed is _MOTIF_DROP.
  153.                     For additional information on selection callback
  154.                     procedures, see _X _T_o_o_l_k_i_t _I_n_t_r_i_n_s_i_c_s-_C _L_a_n_g_u_a_g_e
  155.                     _I_n_t_e_r_f_a_c_e.
  156.  
  157.           XXXXmmmmNNNNttttrrrraaaannnnssssffffeeeerrrrSSSSttttaaaattttuuuussss
  158.                     Specifies the current status of the drop transfer.
  159.                     The client updates this value when the transfer
  160.                     ends and communicates the value to the initiator.
  161.                     The possible values are
  162.  
  163.  
  164.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____SSSSUUUUCCCCCCCCEEEESSSSSSSS  The transfer succeeded.
  165.  
  166.                     XXXXmmmmTTTTRRRRAAAANNNNSSSSFFFFEEEERRRR____FFFFAAAAIIIILLLLUUUURRRREEEE  The transfer failed.
  167.  
  168.  
  169.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  170.           DropTransfer inherits behavior and a resource from OOOObbbbjjjjeeeecccctttt.
  171.           For a complete description of this resource, refer to the
  172.           OOOObbbbjjjjeeeecccctttt reference page.
  173.  
  174.                               OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  175.       NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  176.       ____________________________________________________________________
  177.       XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  178.  
  179.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  180.           OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), XXXXmmmmDDDDiiiissssppppllllaaaayyyy((((3333XXXX)))), XXXXmmmmDDDDrrrraaaaggggCCCCoooonnnntttteeeexxxxtttt((((3333XXXX)))),
  181.           XXXXmmmmDDDDrrrraaaaggggIIIIccccoooonnnn((((3333XXXX)))), XXXXmmmmDDDDrrrrooooppppSSSSiiiitttteeee((((3333XXXX)))), XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrAAAAdddddddd((((3333XXXX)))), and
  182.           XXXXmmmmDDDDrrrrooooppppTTTTrrrraaaannnnssssffffeeeerrrrSSSSttttaaaarrrrtttt((((3333XXXX)))).
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.